/*=========================================================================
 Copyright (c) 2008, Nokia Corporation and/or its subsidiary(-ies).
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
     * Redistributions of source code must retain the above copyright
       notice, this list of conditions and the following disclaimer.
     * Redistributions in binary form must reproduce the above copyright
       notice, this list of conditions and the following disclaimer in the
       documentation and/or other materials provided with the distribution.
     * Neither the name of the Nokia Corporation and/or its subsidiary(-ies)nor the
       names of its contributors may be used to endorse or promote products
       derived from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR 
 TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=========================================================================================*/

#ifndef _ncvConvolutionOp_H_
#define _ncvConvolutionOp_H_

#include "ncvImage.h"
#include "ncvMatrix.h"

/**
 * \class CConvolutionOp
 * \brief Convolution operation.
 * Performs convolution of CNokiaCVImage and a kernel (CNokiaCVMatrix)
 * \note Symbian TClass.
 */

class CConvolutionOp : public CImageOp
	{
public:
	/**
	 * \brief Constructor
	 * \param aImage CNokiaCVImage to use as source
	 * \param aKernel CNokiaCVMatrix Kernel to use for convolution. Only 3x3 and 5x5 matrices are supported.
	 */
	IMPORT_C CConvolutionOp( CNokiaCVImage* aImage, CNokiaCVMatrix& aKernel);

	/**
	 * \brief Do the operation.
	 * \param aTarget CNokiaCVImage to store the result in. The target
	 * must be created before calling this,
	 * \note the function can leave
	 */
	IMPORT_C void DoOperation( CNokiaCVImage* aTarget);

	/**
	 * \brief Get normalization factor
	 */
	IMPORT_C TInt NormFactor() const;

	/**
	 * \brief Set normalization factor. Typically equals to the sum of kernel values.
	 * Each resulting pixel value is divided by the normalization factor.
	 */
	IMPORT_C void NormFactor(TInt aFactor);
private:
	// Strait up direct method for small kernels (3x3 and 5x5)
	void DoConvolution( CNokiaCVImage* aTarget);

	// Calculate the normalization factor
	TInt CalcNormFactor() const;
	inline TUint32 ApplyKernel(CPixelAccess* pa, TPoint aPoint);
	inline TUint32 ApplyKernelBw(CPixelAccess* pa, TPoint aPoint);

	CNokiaCVImage*		iImage;
	CNokiaCVMatrix&	iKernel;

	TInt			iKernRows;
	TInt			iKernCols;
	TInt			iNormFactor;
	TInt			iD;

	};

#endif //_ncvConvolutionOp_H_
